home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / telegard / tgfpu300.zip / TGFPU.DOC < prev    next >
Text File  |  1996-01-20  |  10KB  |  299 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.                                  TGFPU
  18.                    =================================
  19.                     Version 3.00 - January 20, 1996
  20.  
  21.  
  22.                        Telegard File Point Update
  23.                                 for the
  24.                         Telegard 3.0 BBS system
  25.  
  26.  
  27.  
  28.                           Mt. Glacier Software
  29.               Copyright (c) 1992, 1996 by Michael G. Smith
  30.                           All rights reserved.
  31.  
  32.  
  33.  
  34.             Latest version and Support available on my BBS:
  35.  
  36.                            The Twilight Zone
  37.                            Telegard Beta Site
  38.                              (203)688-0675
  39.  
  40.                            FidoNet  1:142/550
  41.                             ITCNET 85:861/101
  42.       2400-33,600/V.32/V.34/V.FC HST Dual Standard (v.Everything)
  43.                (FREQ magic name TGFPU for latest version)
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.                         Purpose and Capabilities
  70.                         ========================
  71.  
  72.     This utility program will QUICKLY set ALL files in a specified File
  73.     Base (.FB) to a specified number of points.  This is useful to set
  74.     points for files that are brought in via FILES2TG, or when you need
  75.     to reset file points in a particular file base.
  76.  
  77.     The utility takes as arguments the desired .FB filename and an integer
  78.     number of file points to set each file entry to.  The utility will only
  79.     process a single .FB file at a time, but group runs can be made via a
  80.     batch file  (see SAMPLE.BAT and TGFAL.DOC enclosed).
  81.  
  82.     If desired, the original .FB file can be kept as a .BAK (backup)
  83.     file for fall-back in case of problems.
  84.  
  85.     An optional LOG file records activity taken by the utility.
  86.  
  87.  
  88.                                 Warranty
  89.                                 ========
  90.  
  91.     This product is provided "as is" without warranty of any kind. The entire
  92.     risk as to the results and  performance of the program is assumed by you.
  93.     Furthermore, the  author does  not warrant, guarantee, or  make any  other
  94.     representations regarding  the use of,  or the  results of the use of the
  95.     program,  and you  rely on the  program and  results  solely at  your own
  96.     risk.  The author  cannot and  will not accept  responsibility for system
  97.     damage, loss of profit, or any other special, consequential or incidental
  98.     damages  resulting  from  the  use  or  inability  to  use this  product.
  99.  
  100.     I've tested it on my system and it's worked fine.  A backup might be a
  101.     good idea before your first run, just in case.  If you do find any bugs,
  102.     please report them using one of the support options below.
  103.  
  104.  
  105.                                Copyright
  106.                                =========
  107.  
  108.     TGFPU is Copyright (c) 1992, 1996 Mt. Glacier Software by Michael G. Smith.
  109.     It is distributed as Freeware.  You are encouraged to use  this utility
  110.     free of  charge.  Any comments/feedback/suggestions would be gladly
  111.     accepted (see Support section below), including a simple note to say
  112.     "Thanks".
  113.  
  114.  
  115.                               Distribution
  116.                               ============
  117.  
  118.     You are encouraged to distribute TGFPU provided that all files contained
  119.     in the archive are distributed in their original and unmodified state.
  120.     No fee is to be charged above a normal minimal distribution fee.
  121.  
  122.  
  123.                               Description
  124.                               ===========
  125.  
  126.     TGFPU is a yet another little utility program I wrote to solve those
  127.     nagging maintenance issues involved in running a Telegard board.  I wrote
  128.     it for Telegard 2.5 in order to set a fixed number of file points for
  129.     files coming in via file echoes and FILES2TG.  Other utilities didn't
  130.     have the speed I desired and thuss TGFPU was born.  TGFPU was designed
  131.     for SPEED!!  The program only updates records if the file points differ
  132.     from the desired value, thus saving additional I/O (and time!).
  133.  
  134.     TGFPU verifies that the specified .FB file is present in FAREAS.DAT
  135.     and locates the .FB file via information stored in FAREAS.DAT.
  136.  
  137.     If /B (Backup) is specified, the input .FB file is renamed to .BAK and
  138.     copied to a *new* .FB file before processing takes place.  If /B is
  139.     _not_ specified, the .FB file is updated in place.
  140.  
  141.     If /L (Log) is specified, the utilities activity is written to the log
  142.     file specified.  If no log file path/name is specified, the utility will
  143.     write to a default file named TGFPU.LOG in the current directory.
  144.  
  145.  
  146.                             Important Notes
  147.                             ===============
  148.  
  149.     1. Option switches can be specified with slash or dash (e.g. /B or -B).
  150.  
  151.     2. If you're running with /B and have a problem (disk full, power
  152.        failure, etc) remember that the .BAK is a RENAME of the original
  153.        .FB file *before* any processing takes place.  It can be simply
  154.        renamed back to .FB to recover!
  155.  
  156.     3. Suggestion:  Create a .BAT (batch) file to automate routine runs
  157.        of TGFPU against file directories.  Refer to the utility TGFAL
  158.        (Telegard File Area Lister) that was also included in this archive
  159.        as an easy way to generate a .BAT file - use of TGFAL is documented
  160.        in file TGFAL.DOC.
  161.  
  162.        Example:
  163.  
  164.        @Echo off
  165.        Rem SAMPLE.BAT - Invoke TGFPU for several directory files
  166.           C:
  167.           CD \BBS
  168.           TGFPU GAMES   1 /LC:\BBS\LOGS\TGFPU.LOG
  169.           TGFPU COMM    1 /LC:\BBS\LOGS\TGFPU.LOG
  170.           TGFPU GRAPHIC 1 /LC:\BBS\LOGS\TGFPU.LOG
  171.           TGFPU UTIL    1 /LC:\BBS\LOGS\TGFPU.LOG
  172.  
  173.  
  174.                                  Usage
  175.                                  =====
  176.  
  177.     TGFPU will attempt to open CONFIG.TG in the current directory, and if not
  178.     found, will search the DOS PATH for it.  Successful completion returns a
  179.     zero condition code, any errors will produce a non-zero return code.
  180.     Return codes (errorlevels) are detailed below.
  181.  
  182.     TGFPU accepts two command line parameters (which are required),
  183.     and up to two command line option switches (which are optional).
  184.  
  185.     Command format is:
  186.  
  187.       TGFPU fbname #pts [/B] [/L[logfile]]
  188.  
  189.     Where:
  190.  
  191.        fbname  - The input file base name to process.
  192.  
  193.                   Notes: Do NOT specify the .FB extension.
  194.                          The input file base must be defined to Telegard
  195.                          (i.e. exist in FAREAS.DAT).
  196.  
  197.           #pts  - Specifies the number of file points to assign to each
  198.                   file in the above specified .FB file.
  199.  
  200.             /B  - Specifies that the original .FB file will be retained as
  201.                   .BAK at end of processing.
  202.  
  203.     /L[logfile] - Specifies that the utilities activities will be logged to
  204.                   the file specified.  If /L is specified with no logfile
  205.                   name, the utility will log to TGFPU.LOG in the current
  206.                   directory.  Note that the logfile specification can be a
  207.                   fully pathed DOS filename.
  208.  
  209.  
  210.     Example commands:
  211.  
  212.        TGFPU GAMES 3        =  Set all files in dir GAMES to 3 points.
  213.                                Directory will be updated in place.
  214.                                No LOG file will be written.
  215.  
  216.        TGFPU UTILS 15 /B    =  Set all files in dir UTILS to 15 points,
  217.                                and create a .BAK backup of the .FB file
  218.                                before processing.
  219.  
  220.        TGFPU MISC 5 /L      =  Set all files in dir MISC to 5 points, and
  221.                                log activity to default file TGFPU.LOG in
  222.                                the current directory.
  223.  
  224.        TGFPU COMM 1 /B /LC:\BBS\LOGS\TGFPU.LOG
  225.                             =  Set all files in dir COMM to 1 point,
  226.                                create a .BAK backup of the .FB file, and
  227.                                log activity to file C:\BBS\LOGS\TGFPU.LOG.
  228.  
  229.  
  230.  
  231.  
  232.                      TGFPU Version 3.00 Files List
  233.                      ==============================
  234.  
  235.       FILE_ID.DIZ      Standard description file for BBS upload.
  236.       RUNTGFPU.BAT     Sample .BAT (batch) file to invoke TGFPU.
  237.       TGFAL.DOC        TGFAL utility complete documentation.
  238.       TGFAL.EXE        TGFAL utility executable program.
  239.       TGFPU.DOC        TGFPU utility complete documentation (this file).
  240.       TGFPU.EXE        TGFPU utility executable program.
  241.       TGFPUSAM.LOG     Sample TGFPU utility LOG file.
  242.  
  243.  
  244.                       Return Codes / ErrorLevels
  245.                       ==========================
  246.  
  247.      0 = Normal completion.
  248.      4 = Invalid or Missing Parameters.
  249.      8 = Error Opening or Reading CONFIG.TG file.
  250.     12 = Error Opening or Reading FAREAS.DAT file.
  251.     16 = Error Opening or Reading/Writing .FB file.
  252.     20 = Error Opening or Writing LOG file.
  253.  
  254.  
  255.                                 Support
  256.                                 =======
  257.  
  258.     I can be reached at the following for support/questions/suggestions about
  259.     this utility (listed in my preferred order):
  260.  
  261.        FIDO:  1:142/550 (FREQ magic name TGFPU for latest version)
  262.      ITCNET: 85:861/101
  263.              Use NetMail for fastest reply.
  264.  
  265.     BBS:  The Twilight Zone
  266.           Telegard Beta Site
  267.           (203)688-0675   HST Dual Standard (v.Everything)
  268.  
  269.     U.S. Mail:  Michael G. Smith
  270.                 14 Oxford Lane
  271.                 Windsor, CT  06095
  272.  
  273.     Phone:      Sorry. No voice support available.
  274.  
  275.  
  276.                                 History
  277.                                 =======
  278.  
  279.     Version    Date     Remarks
  280.     -------    ----     -------
  281.      1.00    07/30/92   Initial General Release (MGSFP100.ZIP).
  282.      3.00    11/20/96   Updated for TG 3.0. Added logging. (TGFPU100.ZIP).
  283.  
  284.  
  285.                         Futures and Enhancements
  286.                         ========================
  287.  
  288.     Well, that all depends.  If I get some positive feedback on this utility,
  289.     I will probably enhance it.  If not, well, it does what I want now...
  290.  
  291.     Some possibilities: (suggestions cheerfully accepted)
  292.  
  293.     - Process directories via a parameter file.
  294.  
  295.     - Speed improvement. (What can I say?  I'm a speed freak...)
  296.  
  297.  
  298.                      -= End of TGFPU.DOC file =-
  299.